Skip to main content
GET
List ledger accounts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
id
string

Filter by account ID.

ledger_id
string

Filter by ledger ID.

invoicing_entity_id
string

Filter by invoicing entity ID.

code
string

Filter by exact account code.

name
string

Filter by exact account name.

type
enum<string>

Filter by account type.

Available options:
asset,
contra_asset,
liability,
contra_liability,
equity,
revenue,
contra_revenue,
expense
client_provider_id
string

Filter by connected provider ID.

Search account name or code.

year
integer | null

Year used to calculate period balances.

Required range: 2000 <= x <= 2100
quarter
integer | null

Quarter used to calculate period balances.

Required range: 1 <= x <= 4
sort_by
enum<string> | null

Field used to sort accounts.

Available options:
name,
code
order
enum<string> | null

Sort direction.

Available options:
asc,
desc

Response

200 - application/json
meta
object
required

Pagination metadata.

data
object[]
required

Ledger accounts returned by the request.